/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.sysds.runtime.compress.plan;

import org.apache.sysds.runtime.compress.CompressedMatrixBlock;
import org.apache.sysds.runtime.matrix.data.MatrixBlock;

/**
 * Interface for constructing an compression plan that is able to compress sequences of matrix blocks with the same
 * scheme
 */
public interface IPlanEncode {

	/**
	 * Encode a given matrix block subject to the plan given, while erroring out in case of breaking compression
	 * 
	 * @param in The matrix block to encode
	 * @return A Compressed Matrix block with the safe scheme applied.
	 */
	public CompressedMatrixBlock encode(MatrixBlock in);

	/**
	 * Given a block expand the plan to enable encoding of the given block.
	 * 
	 * @param in The bock
	 */
	public void expandPlan(MatrixBlock in);

}
